Improve user clarity in square rotation example.#59
Closed
Somsubhra-Nandi wants to merge 1 commit intoneuroinformatics-unit:mainfrom
Closed
Improve user clarity in square rotation example.#59Somsubhra-Nandi wants to merge 1 commit intoneuroinformatics-unit:mainfrom
Somsubhra-Nandi wants to merge 1 commit intoneuroinformatics-unit:mainfrom
Conversation
Author
|
Hi @lauraporta, I've submitted this small improvement to the examples to help with user onboarding. Happy to make any changes if needed! |
Member
|
Hi @Somsubhra-Nandi, thank you for your interest in derotation and for submitting a PR. The examples are mostly meant to fill in the sphinx gallery documentation, so I guess that's what was not clear to a new user! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
While exploring the codebase, I noticed the rotate_and_derotate_a_square.py example script opens a window but doesn't provide terminal feedback, which could be confusing for new users. I've added print statements to guide the user to close the window to successfully finish the script.